Esx Settings Depots SyncSchedule Schedule

The Esx Settings Depots SyncSchedule Schedule schema defines a schedule.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "type": "string",
    "skip": 0,
    "minute": 0,
    "hour": 0,
    "day_of_month": 0,
    "day_of_week": "string"
}

string

type

Required

Frequency of the schedule.

For more information see: Esx Settings Depots SyncSchedule Recurrence.

This property was added in vSphere API 7.0.0.0.

integer As int64 As int64

skip

Optional

This determines the units of Esx Settings Depots SyncSchedule Recurrence to skip before the scheduled task runs again. For example, value of 1 for HOURLY type means the scheduled task runs every 2 hours. The value must be within the range 0 to 998.

This property was added in vSphere API 7.0.0.0.

If missing or null, no unit is skipped.

integer As int64 As int64

minute

Optional

Minute at which schedule should be run. The value must be within the range 0 to 59.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Depots SyncSchedule Recurrence.HOURLY, Esx Settings Depots SyncSchedule Recurrence.DAILY, Esx Settings Depots SyncSchedule Recurrence.WEEKLY, or Esx Settings Depots SyncSchedule Recurrence.MONTHLY_BY_DAY.

integer As int64 As int64

hour

Optional

Hour at which schedule should be run. The value must be within the range 0 to 23.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is one of Esx Settings Depots SyncSchedule Recurrence.DAILY, Esx Settings Depots SyncSchedule Recurrence.WEEKLY, or Esx Settings Depots SyncSchedule Recurrence.MONTHLY_BY_DAY.

integer As int64 As int64

day_of_month

Optional

Day at which schedule should be run. The value must be within the range 1 to 31. If the value exceeds the total number of days in the month, the schedule will run on the last day of the month.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Depots SyncSchedule Recurrence.MONTHLY_BY_DAY.

string

day_of_week

Optional

Day of the week when schedule should be run

For more information see: Esx Settings Depots SyncSchedule DayOfWeek.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Esx Settings Depots SyncSchedule Recurrence.WEEKLY.